home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Diamond Collection / The Diamond Collection (Software Vault)(Digital Impact).ISO / cdr27 / nowthn11.zip / NOW&THEN.DOC < prev    next >
Text File  |  1995-02-25  |  16KB  |  443 lines
  1.                                   
  2.                                   
  3.                                   
  4.                                   
  5.                                   
  6.                                   
  7.                                   
  8.                                   
  9.                                   
  10.                                   
  11.                                   
  12.                                   
  13.                                   
  14.                                   
  15.                                   
  16.                                   
  17.                                   Now & Then
  18.                                  Version  1.1
  19.                     ──────────────────────────────────────
  20.                      Copyright 1995 by Computer Solutions
  21.                              All Rights Reserved
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.                   P R O G R A M    D O C U M E N T A T I O N
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.       
  54.       
  55.       
  56.       
  57.       
  58.       (For a quick summary of options, type NOW&THEN at the dos prompt.)
  59.   ┌───────────────────╖
  60. ──┤ About The Program ╟───────────────────────────────────────────────────────
  61.   ╘═══════════════════╝
  62.  
  63. "Now & Then" is a small program which will execute a DOS command or program
  64. one time during a user defined period of time, which is measured in days.
  65.  
  66. Now & Then was created because of my desire for perfection (not that this
  67. program claims to be perfect).  The commercial utility I was using lacked the
  68. flexibility I needed.  This sent me on a search of a similar utility on the net
  69. and on local bulletin boards.  I found half-a-dozen possibilities, but none of
  70. those were flexible enough either.  So I decided to write my own.
  71.  
  72. While writing Now & Then, I tried to keep other users in mind as well.  Program
  73. functionality and flexibility is the most important aspect, second only to ease
  74. of use.  This documentation alone proves that I kept the rest of the world in
  75. mind.  I can not believe I am the only person who needs such functionality.
  76.  
  77. Many of the programs I found have various limitations with the data file.  Some
  78. require the data file to reside in the root directory.  Others require the data
  79. file to reside in the same directory as the program itself.
  80.  
  81. These programs also have limitations with the commands they can execute.  Some
  82. programs require that the commands are contained in a specific BAT file in a
  83. specific location.  Some programs limit the number of options the user can pass
  84. with the command.  Some programs only allow one command executed per day.
  85. Other programs have a slew of required command line parameters.  
  86.  
  87. I wanted a program with few or no limitations, and Now & Then is the result.
  88.  
  89.  
  90.   ┌──────────────────╖
  91. ──┤   How It Works   ╟────────────────────────────────────────────────────────
  92.   ╘══════════════════╝
  93.  
  94. Now & Then creates a data file which keeps up with the date each command was
  95. last executed.  The entire command line is kept for each command, including all
  96. options.  This allows the user to execute the same program with different
  97. options on different days.
  98.  
  99. By allowing the user to specify which data file to use, Now & Then is able to
  100. keep track of the same set of commands for different purposes.  For example, my
  101. office has five networked computers.  Now & Then resides on our server and is
  102. used to perform daily maintenance for each machine.  The same set of commands
  103. runs on each machine, therefore the need for each machine to have a separate
  104. data file.
  105.  
  106. There is a minor DOS limitation which affects Now & Then.  DOS makes a copy
  107. of the environment for each program executed.  Unfortunately, there is no DOS
  108. supported and documented method of accessing the parent environment.  The
  109. command that Now & Then executes has its own environment, which is deleted when
  110. the command is completed.  Therefore, if the command alters the environment
  111. (such as a SET or PATH command), it will not alter the master environment.  A
  112. command such as NOW&THEN 1 SET FIRSTBOOT=TRUE would not have an effect, and
  113. FIRSTBOOT would not be set.  This is DOS's behavior and is beyond my control.  
  114.  
  115. I added ERRORLEVEL support to version 1.1 of Now & Then.  This allows a batch
  116. file to determine if the command was scheduled to run.  If the command was
  117. scheduled, then the batch file can run the command directly.  This solves the
  118. problem with the NOW&THEN 1 SET FIRSTBOOT=TRUE example above.  There are BAT
  119. files included which illustrate how to check the ERRORLEVEL value in DOS.
  120.      
  121.      
  122.      February, 1995               Now & Then                         Page 1
  123.   ┌─────────────────────╖
  124. ──┤ Command Line Syntax ╟─────────────────────────────────────────────────────
  125.   ╘═════════════════════╝
  126.  
  127. Syntax:
  128.  
  129.       NOW&THEN [options] interval-in-days command
  130.             
  131. [options]
  132.       Options allow the user to customize various settings.
  133.  
  134. interval-in-days
  135.       This specifies the frequency which the command should be executed.
  136.  
  137. command
  138.       This specifies the command which to execute.  Now & Then supports
  139.       commands up to 255 characters in length.  Note, however, that most
  140.       versions of DOS only allow a command line of 127 characters.  The 4DOS
  141.       COMMAND.COM replacement is one of the exceptions.
  142.       
  143.       The user may pass an infinite number of parameters with the command.
  144.       However, if parameters beginning with "-" or "/" are passed to the
  145.       command, the entire command must be enclosed in quotations.  This is
  146.       required because of the way Now & Then parses its own parameters.
  147.       Without the quotations, Now & Then thinks the parameters were meant
  148.       for it, not for the command.
  149.  
  150.  
  151.      
  152.      
  153.      
  154.      
  155.      
  156.      
  157.      
  158.      
  159.      
  160.      
  161.      
  162.      
  163.      
  164.      
  165.      
  166.      
  167.      
  168.      
  169.      
  170.      
  171.      
  172.      
  173.      
  174.      
  175.      
  176.      
  177.      
  178.      
  179.      
  180.      
  181.      
  182.      
  183.      
  184.      
  185.      
  186.      February, 1995               Now & Then                         Page 2
  187.   ┌──────────────────────╖
  188. ──┤ Command Line Options ╟────────────────────────────────────────────────────
  189.   ╘══════════════════════╝
  190.  
  191.               ∙ may be specified in any order
  192.               ∙ may be upper or lower case
  193.               ∙ must be preceded by a slash (/) or a minus (-)
  194.               ∙ must be separated by a space ( )
  195.  
  196. /? (Help)            
  197.        Displays a usage screen.
  198.  
  199. /q (Quite Mode)         
  200.        Normally the program displays informational output telling the user
  201.        if the command was executed or not.  This option suppresses that
  202.        informational output.  Combined with the >NUL redirection (see below),
  203.        this will completely disable output from most programs.
  204.  
  205. /a (Always)
  206.        Performs the command even if it is not scheduled for today.  By default,
  207.        this switch updates the data file to indicate that the command was
  208.        executed today.
  209.  
  210. /n (Nothing)         
  211.        Don't actually perform the command.  When used in conjunction with the
  212.        ERRORLEVEL value, this switch allows a .BAT file to determine if the
  213.        command should be executed, without actually performing the command.
  214.        This is very useful with the SET FIRSTBOOT=1 example explained in
  215.        "How It Works."  When used in conjunction with the update switch (/u),
  216.        the /n switch may also be used for testing purposes, to determine if the
  217.        command is scheduled to run or not.  Idea taken from 4DOS, and has since
  218.        been very useful.
  219.  
  220. /u (Update)         
  221.        Don't update the data file.  If the command is scheduled to execute, the
  222.        data file is normally updated so the command will not run until it is
  223.        scheduled to run again.  This option prevents the data file update.
  224.  
  225. /f=file.ext (Data file name)
  226.        Specify the name of the date file to use.  The user can specify the
  227.        entire path of the file and the extension.  If a path is not specified, 
  228.        the current directory is used.  If an extension is not specified, .DAY
  229.        is used.  If this option is omitted, a data file will be created in the
  230.        same directory as the Now & Then executable.
  231.  
  232. >NUL (Output Redirection)
  233.        This is actually part of DOS, but it is quite handy when used in
  234.        conjunction with Now & Then.  DOS will suppress program output when >NUL
  235.        is placed at the end of the command.  When used in conjunction with the
  236.        Quiet switch (/q), this will usually suppress the output of the command.
  237.        Note that some programs write directly to video, bypassing the BIOS.
  238.        >NUL does not suppress the output of such programs.
  239.  
  240.  
  241.      
  242.      
  243.      
  244.      
  245.      
  246.      
  247.      
  248.      
  249.      
  250.      February, 1995               Now & Then                         Page 3
  251.   ┌────────────────────╖
  252. ──┤ Included Utilities ╟──────────────────────────────────────────────────────
  253.   ╘════════════════════╝
  254.   
  255. Included is a utility named LISTDATA, which reads a Now & Then data file and
  256. prints each command stored in the data file, as well as the date the command
  257. was last executed.
  258.  
  259. There is no great use for such a utility.  However, it took all of ten seconds
  260. to cut and paste the code from Now & Then into a new window and compile it into
  261. a separate program.
  262.  
  263. The syntax for LISTDATA is:  LISTDATA filename, where filename is the name of
  264. the Now & Then data file.
  265.   
  266.  
  267.   ┌──────────────────╖
  268. ──┤  Thank You List  ╟────────────────────────────────────────────────────────
  269.   ╘══════════════════╝
  270.   
  271. The following shareware authors deserve much thanks for their work.  I have
  272. taken ideas from their programs and documentation for use in Now & Then.
  273.  
  274. Program Ideas
  275.  
  276.   Gene Allison, author of ONCEADAY         Joseph Sheppard, author of DayBat
  277.   Stephen Baines, author of Once Only      William Waldrop, author of Once-A
  278.   Samuel Kaplin, author of Interval
  279.  
  280. Documentation Ideas
  281.  
  282.   Chris S. Craig, author of ScopeTrax      Andy Hakim, author of NoHiss
  283.   Nicola Ferioli, author of VocPack        Tom Rathborne, author of ModUtils
  284.  
  285.  
  286. The following people have contacted me about Now & Then.  Very few people send
  287. mail to FreeWare/ShareWare authors.  I feel appreciated when someone sends me
  288. mail, and I like to thank them for it.
  289.     
  290.   Program Suggestions
  291.  
  292.     Niels Ull Jacobsen requested the always switch (/a).
  293.   
  294.   Bug Reports
  295.  
  296.     Jim Gorges informed me that the program did not support 8088 machines.
  297.     My in-house projects are compiled with 286 code, and I did not think
  298.     about changing the compiler options for Now&Then.
  299.  
  300.  
  301. I would also like to thank the following people for reviewing this
  302. documentation before its release:
  303.  
  304.     Aimee Richards, the love of my life and co-owner of Computer Solutions.
  305.  
  306.     Gary Fambrough, Charlie Rowland, and Alyce Hardee, my co-workers at
  307.     High Q Incorporated. 
  308.  
  309.   
  310.  
  311.  
  312.  
  313.  
  314.      February, 1995               Now & Then                         Page 4
  315.   ┌──────────────────╖
  316. ──┤ Future Additions ╟────────────────────────────────────────────────────────
  317.   ╘══════════════════╝
  318.  
  319. This program does everything I need it to do, and then some.  However, there
  320. is always room for improvement.  Please contact me if you would like to see a
  321. particular feature added.  I released the first version on January 11, 1995.
  322. Due to user response, I released a second version on February 22, 1995.
  323.  
  324. Planned additions:  
  325.   
  326.   Command line examples provided in this documentation.
  327.   
  328.   Implement the functionality of LISTDATA directly in Now & Then.
  329.   
  330.   The ability to specify once a month, week, or year, followed by a day
  331.   of week or date specification.  These features are in the Once-A utility
  332.   written by William Waldrop.
  333.  
  334.  
  335.   ┌──────────────────╖
  336. ──┤ Revision History ╟────────────────────────────────────────────────────────
  337.   ╘══════════════════╝
  338.  
  339. 1.0    01/11/95  First release.
  340.  
  341. 1.01   02/13/95  Recompiled to support 8088 machines.  Thanks to Jim Gorges
  342.                  for this one.  This revision was sent to Jim only.
  343.  
  344. 1.10   02/23/95  Broke down and wrote a new release.  Features included in this
  345.                  release are:
  346.  
  347.                  Added the always switch (/a) at Niels Ull Jacobsen's request.
  348.                  
  349.                  Added the ability to determine if a command was scheduled to
  350.                  run based on DOS's ERRORLEVEL value.
  351.                  
  352.                  Added error message when wrong number of arguments were used.
  353.                  Previously I displayed the usage screen, which failed to
  354.                  explain why the command didn't work.
  355.  
  356.                  Added the LISTDATA utility to list the contents of a
  357.                  Now & Then data file.
  358.  
  359.                  Modified the /n switch so that it does update the file.  This
  360.                  was primarily to facilitate the new ERRORLEVEL support.  If
  361.                  the user needs the previous functionality of /n, use /u in
  362.                  combination with /n.
  363.  
  364.                  Rewrote most of this documentation. 
  365.  
  366.  
  367.  
  368.  
  369.      
  370.      
  371.      
  372.      
  373.      
  374.      
  375.      
  376.      
  377.      
  378.      February, 1995               Now & Then                         Page 5
  379.   ┌──────────────────╖
  380. ──┤ About The Author ╟────────────────────────────────────────────────────────
  381.   ╘══════════════════╝
  382.  
  383. Computer Solutions is a small, computer consulting firm which Aimee & I
  384. started in the Summer of 1994.  Feel free to contact us with any ideas,
  385. comments, suggestions, or questions you may have.
  386.  
  387.                  US Mail │ Computer Solutions
  388.                          │ 12111 West Markham Suite 14-121
  389.                          │ Little Rock, AR  72211
  390.                          │
  391.                    Pager │ (501) 660-9787
  392.                          │
  393.          Electronic Mail │ jon.robertson@grapevine.lrk.ar.us
  394.                          │
  395.           Bulletin Board │ Ferret Face
  396.                          │ (501) 791-0124
  397.                          │ 2400/14400/28800 baud, HST/v.32/v.FC
  398.                          │ Username: Jon Robertson
  399.                         
  400.  
  401.   ┌──────────────────╖
  402. ──┤    Legal Talk    ╟────────────────────────────────────────────────────────
  403.   ╘══════════════════╝
  404.      
  405. This program is FreeWare.  Individuals are granted the right to freely use
  406. Now & Then without any concern for registration.  Corporate users must contact
  407. me for a site license agreement.
  408.  
  409. While this program works great with the six machines I've used, I can not
  410. guarantee that it will work on every system.  Therefore, this program carries
  411. no warranties, expressed or implied.  If you have a problem, please contact me.
  412.  
  413. You may freely distribute Now & Then to others as long as:
  414.  
  415.                  ∙  Only the original files are distributed
  416.                  ∙  No changes are made to any of the files
  417.                  ∙  No money is charged for the program
  418.  
  419. Now & Then may be freely included on any form of compilation disk or
  420. shareware library, except disks or libraries that charge *per program*,
  421. rather than per disk of programs.
  422.  
  423. This program is not crippled in any way and does not contain any 'nag'
  424. messages.  In fact, if the right options are specified, nothing is ever
  425. displayed on the screen.
  426.  
  427. Now & Then and this documentation are Copyright 1995 by Computer Solutions,
  428. All Rights Reserved.  The author of this program is not liable for any damage
  429. caused by its use.  By using this program, you agree to the above conditions.
  430.  
  431.  
  432.      
  433.      
  434.      
  435.      
  436.      
  437.      
  438.      
  439.      
  440.      
  441.      
  442.      February, 1995               Now & Then                         Page 6
  443.